<!DOCTYPE html>
<html lang="en-US">
    <head>
        <title>Text::Metaphone - A modern soundex. Phonetic encoding of words. - metacpan.org</title>
        <link rel="preload" as="fetch" href="https://metacpan.org/account/login_status" crossorigin="anonymous" />
        <link href="https://metacpan.org/_assets/b8ccceeed47a0652049703d99326a9cea4933443.css" rel="stylesheet" type="text/css">
        <script src="https://metacpan.org/_assets/6bfedafe2d7caa915b7d84f61b45936818e3242e.js" type="text/javascript" defer></script>
        <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of Text-Metaphone - MetaCPAN" href="https://metacpan.org/dist/Text-Metaphone/releases.rss" />
        <link rel="canonical" href="./Text::Metaphone.html" />
        <meta name="description" content="A modern soundex. Phonetic encoding of words." />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5">
        <link rel="shortcut icon" href="https://metacpan.org/static/icons/favicon.ico">
        <link rel="apple-touch-icon" sizes="152x152" href="https://metacpan.org/static/icons/apple-touch-icon.png">
        <link rel="search" href="https://metacpan.org/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN">
        <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          (function(skey, ga_id){
            ga('create', ga_id, {
              siteSpeedSampleRate : 100,
              storage             : 'none',
              clientId            : localStorage.getItem(skey)
            });
            ga(function(tracker) {
              localStorage.setItem(skey, tracker.get('clientId'));
            });
            ga('send', 'pageview');
          })('ga:clientId', 'UA-27829474-1');
        </script>
<meta name="twitter:card"        content="summary" />
<meta name="twitter:url"         content="https://metacpan.org/pod/Text::Metaphone" />
<meta name="twitter:title"       content="Text::Metaphone" />
<meta name="twitter:description" content="A modern soundex. Phonetic encoding of words." />
<meta name="twitter:site"        content="metacpan" />
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="header-logo-large hidden-xs">
              <a href="https://metacpan.org/" tabindex="0">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#logo" />
                </svg>
              </a>
            </div>
            <div class="header-logo-icon visible-xs">
              <a href="https://metacpan.org/">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#dots" />
                </svg>
              </a>
            </div>
            <ul class="nav navbar-nav menu-items hidden-xs hidden-sm">
              <li><a href="https://metacpan.org/about">About</a></li>
              <li><a href="https://metacpan.org/about/sponsors">Sponsor</a></li>
              <li><a href="https://grep.metacpan.org/">grep::cpan</a></li>
              <li><a href="https://metacpan.org/recent">Recent</a></li>
              <li><a href="https://metacpan.org/about/faq">FAQ</a></li>
              <li><a href="https://metacpan.org/tools">Tools</a></li>
              <li><a href="https://fastapi.metacpan.org/">API</a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <button type="button" class="searchbar-btn visible-xs visible-sm">
                    <i class="fa fa-search button-fa-icon"></i>
                </button>
                <form action="https://metacpan.org/search" class="searchbar-form visible-md visible-lg search-form form-horizontal">
                   <input type="hidden" name="size" id="metacpan_search-size" value="20">
                  <div class="form-group">
                      <div class="search-group">
                        <i class="fa fa-search"></i>
                        <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value="">
                      </div>
                  </div>
                </form>
                    <li class="icon-slidepanel visible-xs visible-sm">
                      <button data-toggle="slidepanel" data-target=".slidepanel">
                        <span class="button-fa-icon">
                          <i class="fa fa-bars slidepanel-open"></i>
                          <i class="fa fa-times slidepanel-close"></i>
                        </span>
                      </button>
                    </li>
                <form action="https://metacpan.org/account/logout" method="POST" id="metacpan-logout"></form>
                <li class="dropdown logged_in" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li><a href="https://metacpan.org/account/identities">Identities</a></li>
                        <li><a href="https://metacpan.org/account/profile">Profile</a></li>
                        <li><a href="https://metacpan.org/account/favorite/list">Favorites</a></li>
                        <li>
                            <a href="./Text::Metaphone.html#" type="button" onclick="$('#metacpan-logout').submit(); return false">
                              Logout
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_out" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li>
                            <a href="https://metacpan.org/login/github">
                                <i class="fab fa-github fa-fw"></i>
                                GitHub
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/twitter">
                                <i class="fab fa-twitter fa-fw"></i>
                                Twitter
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/google">
                                <i class="fab fa-google fa-fw"></i>
                                Google
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_placeholder">
                    <button>
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                    </button>
                </li>
            </ul>
        </nav>
        <div class="page-content ">
          <!--
          <div class="top-notify-banner">
            <i class="fas fa-info-circle"></i>
          </div>
          -->
          <nav class="sidebar">
            <div class="slidepanel">
              <ul class="nav-list ">
    <li class="nav-header no-margin-top">
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of Text-Metaphone was released.">
      <span class="relatize">06 Aug 2016 05:43:51 UTC</span>
    </li>
  <li>
    Distribution: <a href="https://metacpan.org/dist/Text-Metaphone">Text-Metaphone</a>
  </li>
  <li>
    Module version: 20160805
  </li>
  <li>
    <a data-keyboard-shortcut="g s" href="https://metacpan.org/dist/Text-Metaphone/source/Metaphone.pm">Source</a>
    (<a href="https://metacpan.org/dist/Text-Metaphone/source/Metaphone.pm?raw=1">raw</a>)
  </li>
  <li>
    <a data-keyboard-shortcut="g b" href="https://metacpan.org/dist/Text-Metaphone/source">Browse</a>
    (<a href="https://metacpan.org/dist/Text-Metaphone/source?raw=1">raw</a>)
  </li>
    <li>
      <a data-keyboard-shortcut="g c" href="https://metacpan.org/dist/Text-Metaphone/changes">Changes</a>
    </li>
    <li>
      <a rel="noopener nofollow" class="nopopup" href="https://metacpan.org/release/Text-Metaphone">Homepage</a>
    </li>
    <li>
      <a class="nopopup" href="https://metacpan.org/dist/Text-Metaphone/contribute">How to Contribute</a>
    </li>
    <li>
        <a rel="noopener nofollow" data-keyboard-shortcut="g r" href="https://github.com/schwern/Text-Metaphone">Repository</a>
    </li>
    <li>
      <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://github.com/schwern/Text-Metaphone/issues">Issues</a>
      (0)
    </li>
    <li>
      <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=Text-Metaphone+20160805" title="Matrix">Testers</a>
        <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/T/Text-Metaphone.html?oncpan=1&amp;distmat=1&amp;version=20160805&amp;grade=2" style="color: #090">32</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/T/Text-Metaphone.html?oncpan=1&amp;distmat=1&amp;version=20160805&amp;grade=3" style="color: #900">0</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/T/Text-Metaphone.html?oncpan=1&amp;distmat=1&amp;version=20160805&amp;grade=4">0</a>)</span>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/MSCHWERN/Text-Metaphone-20160805">Kwalitee</a>
    </li>
    <li>
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on Text-Metaphone who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)">
      Bus factor: 0
      </div>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpancover.com/latest/Text-Metaphone-20160805/index.html">100.00% Coverage </a>
    </li>
    <li>
      License: perl_5
    </li>
    <li>
      Perl: v5.6.0
    </li>
    <li class="nav-header">Activity</li>
    <li>
<div class="activity-graph">
    <img src="https://metacpan.org/dist/Text-Metaphone/activity.svg?res=month" />
    <div class="comment">24 month</div>
</div>
    </li>
    <li class="nav-header">Tools</li>
    <li>
      <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/M/MS/MSCHWERN/Text-Metaphone-20160805.tar.gz">
      Download (<span itemprop="fileSize">9.52KB</span>)</a>
    </li>
    <li>
      <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FMSCHWERN%2FText-Metaphone-20160805%2FMetaphone.pm">
        MetaCPAN Explorer
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Text-Metaphone/permissions">
        Permissions
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Text-Metaphone/releases.rss">
        Subscribe to distribution
      </a>
    </li>
    <li>
      <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog">
        Install Instructions
      </button>
    </li>
    <li>
      <form action="https://metacpan.org/search">
        <input type="hidden" name="q" value="dist:Text-Metaphone">
        <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
      </form>
    </li>
    <li>
      <form action="https://grep.metacpan.org/search">
        <input type="hidden" name="qd" value="Text-Metaphone">
        <input type="hidden" name="source" value="metacpan">
        <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
     </form>
    </li>
    <li class="version-jump">
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/Metaphone.pm&#39;" class="form-control tool-bar-form">
  <option disabled selected>Jump to version</option>
<option
  disabled
  value="MSCHWERN/Text-Metaphone-20160805"
>20160805
  (MSCHWERN on 2016-08-06)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-20160804"
>20160804
  (MSCHWERN on 2016-08-05)</option>
<optgroup label="BackPAN">'
<option
  
  value="MSCHWERN/Text-Metaphone-20081017"
>20081017
  (MSCHWERN on 2008-10-17)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-2.01"
>2.01
  (MSCHWERN on 2008-10-10)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-2.00"
>2.00
  (MSCHWERN on 2007-06-30)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.96"
>1.96
  (MSCHWERN on 1999-03-04)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.95"
>1.95
  (MSCHWERN on 1999-01-27)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.94"
>1.94
  (MSCHWERN on 1999-01-22)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.93"
>1.93
  (MSCHWERN on 1999-01-22)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.92"
>1.92
  (MSCHWERN on 1999-01-06)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-0.02"
>0.02
  (MSCHWERN on 1997-12-02)</option>
</optgroup>
</select>
    </li>
    <li class="version-diff">
<select onchange="document.location.href='/release/MSCHWERN/Text-Metaphone-20160805/diff/' + encodeURIComponent(this.value) + '/Metaphone.pm'
" class="form-control tool-bar-form">
  <option disabled selected>Diff with version</option>
<option
  disabled
  value="MSCHWERN/Text-Metaphone-20160805"
>20160805
  (MSCHWERN on 2016-08-06)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-20160804"
>20160804
  (MSCHWERN on 2016-08-05)</option>
<optgroup label="BackPAN">'
<option
  
  value="MSCHWERN/Text-Metaphone-20081017"
>20081017
  (MSCHWERN on 2008-10-17)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-2.01"
>2.01
  (MSCHWERN on 2008-10-10)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-2.00"
>2.00
  (MSCHWERN on 2007-06-30)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.96"
>1.96
  (MSCHWERN on 1999-03-04)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.95"
>1.95
  (MSCHWERN on 1999-01-27)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.94"
>1.94
  (MSCHWERN on 1999-01-22)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.93"
>1.93
  (MSCHWERN on 1999-01-22)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.92"
>1.92
  (MSCHWERN on 1999-01-06)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-0.02"
>0.02
  (MSCHWERN on 1997-12-02)</option>
</optgroup>
</select>
    </li>

    <li>
<ul class="dependencies">
  <li class="nav-header">Dependencies</li>
  <li><a href="https://metacpan.org/pod/Test::More" title="Test::More" class="ellipsis">Test::More</a></li>
  <li><i class="ttip" title="dynamic_config enabled">and possibly others</i></li>
  <li>
    <hr>
  </li>
  <li>
    <a href="https://metacpan.org/module/Text::Metaphone/requires">Reverse dependencies</a>
  </li>
  <li>
    <a href="http://deps.cpantesters.org/?module=Text%3A%3AMetaphone">CPAN Testers List</a>
  </li>
  <li>
    <a href="https://cpandeps.grinnz.com/?dist=Text-Metaphone">Dependency graph</a>
  </li>
</ul>
    </li>
    <li class="nav-header">Permalinks</li>
    <li>
      <a href="https://metacpan.org/release/MSCHWERN/Text-Metaphone-20160805/view/Metaphone.pm">This version</a>
    </li>
    <li>
      <a href="./Text::Metaphone.html">Latest version</a>
    </li>
    <li>
<div class="plussers">
<div class="nav-header">++ed by:</div>
<div>
    1 non-PAUSE user
</div>
</div>
    </li>
    <li>
<div id="metacpan_contributors">
  <div>
    <button class="btn-link"
      onclick="$(this).hide(); $('#metacpan_contributors ul').slideDown(); return false;"
    >and 1 contributors</button>
  </div>
  <ul style="display: none">
    <li class="contributor"
      data-contrib-email="schwern@pobox.com"
    >
      <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e?d=identicon&amp;s=20" />
      Michael G Schwern
    </li>
  </ul>
</div>
    </li>
              </ul>
            </div>
          </nav>
          <div class="content-navigation">
<div class="breadcrumbs">
  <span>
    <a data-keyboard-shortcut="g a" rel="author" href="https://metacpan.org/author/MSCHWERN" class="author-name">Michael G Schwern</a>
  </span>
  <span>&nbsp;/&nbsp;</span>
  <div class="release dist-release status-latest maturity-released">
    <span class="dropdown"><b class="caret"></b></span>
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/Metaphone.pm&#39;" class="">
<option
  selected
  value="MSCHWERN/Text-Metaphone-20160805"
>20160805
  (MSCHWERN on 2016-08-06)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-20160804"
>20160804
  (MSCHWERN on 2016-08-05)</option>
<optgroup label="BackPAN">'
<option
  
  value="MSCHWERN/Text-Metaphone-20081017"
>20081017
  (MSCHWERN on 2008-10-17)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-2.01"
>2.01
  (MSCHWERN on 2008-10-10)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-2.00"
>2.00
  (MSCHWERN on 2007-06-30)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.96"
>1.96
  (MSCHWERN on 1999-03-04)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.95"
>1.95
  (MSCHWERN on 1999-01-27)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.94"
>1.94
  (MSCHWERN on 1999-01-22)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.93"
>1.93
  (MSCHWERN on 1999-01-22)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-1.92"
>1.92
  (MSCHWERN on 1999-01-06)</option>
<option
  
  value="MSCHWERN/Text-Metaphone-0.02"
>0.02
  (MSCHWERN on 1997-12-02)</option>
</optgroup>
</select>
    <a data-keyboard-shortcut="g d" class="release-name" href="https://metacpan.org/dist/Text-Metaphone">Text-Metaphone-20160805</a>
  </div>
<span class="river-gauge-gauge">
  <svg width="24px"
       height="15px"
       version="1.1"
       xmlns="http://www.w3.org/2000/svg"
       xmlns:xlink="http://www.w3.org/1999/xlink">

    <g>
      <title>        River stage one &#10;
          • 2 direct dependents &#10;          • 3 total dependents
      </title>

      <rect x="0"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="5"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="10"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="15"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="20"  y="0" width="4" height="15" fill="#e4e2e2" />
    </g>
  </svg>

</span>
<div id="Text-Metaphone-fav" class="logged_in">
<form action="https://metacpan.org/account/favorite/add" style="display: inline" onsubmit="return favDistribution(this)">
    <input type="hidden" name="remove" value="0">
    <input type="hidden" name="release" value="Text-Metaphone-20160805">
    <input type="hidden" name="author" value="MSCHWERN">
    <input type="hidden" name="distribution" value="Text-Metaphone">
    <button type="submit" class="favorite highlight"><span>1</span> ++</button>
</form>
</div>
<div class="logged_out">
<a href="./Text::Metaphone.html" onclick="alert('Please sign in to add favorites'); return false" class="favorite highlight">
<span>1</span> ++</a>
</div>
   / <span>Text::Metaphone</span>
</div>
          </div>
          <main class="content">

<input id="HANDOFF" type="checkbox" class="notification-toggle-checkbox" />
<div id="metacpan_notification" class="well collapsed notify-HANDOFF">
    <label class="remove-notification" for="HANDOFF" >
      <i class="fa fa-fw fa-times black"></i>
    </label>
    <div id="metacpan_notification-container">
      <h2>Take me over?</h2>
      <div>
The maintainer of this distribution is looking for someone to take over!
        If you're interested then please contact them via
        <a href="mailto:mschwern@cpan.org?subject=Take%20over%20Text%3A%3AMetaphone%3F&amp;body=Hello%2C%0A%0AI%27m%20interested%20in%20taking%20over%20the%20Text%3A%3AMetaphone%20module.%20If%20you%20can%20grant%20me%20the%20privilege%20I%20will%20release%20the%20next%20version.%0A%0A">email</a>.
        <a href="https://metacpan.org/about/faq#howtoadoptadistribution"><i class="fa fa-info-circle"></i></a>
      </div>
  </div>
</div>

<nav class="toc">
  <div class="toc-header"><strong>Contents</strong></div>
<ul>
  <li><a href="./Text::Metaphone.html#NAME">NAME</a></li>
  <li><a href="./Text::Metaphone.html#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="./Text::Metaphone.html#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="./Text::Metaphone.html#FUNCTIONS">FUNCTIONS</a>
    <ul>
      <li>
        <ul>
          <li><a href="./Text::Metaphone.html#Metaphone">Metaphone</a></li>
        </ul>
      </li>
    </ul>
  </li>
  <li><a href="./Text::Metaphone.html#CAVEATS">CAVEATS</a>
    <ul>
      <li>
        <ul>
          <li><a href="./Text::Metaphone.html#Metaphone-algorithm-changes">Metaphone algorithm changes</a></li>
        </ul>
      </li>
    </ul>
  </li>
  <li><a href="./Text::Metaphone.html#AUTHOR">AUTHOR</a></li>
  <li><a href="./Text::Metaphone.html#SEE-ALSO">SEE ALSO</a>
    <ul>
      <li><a href="./Text::Metaphone.html#Man-pages">Man pages</a></li>
      <li><a href="./Text::Metaphone.html#Books,-Journals-and-Magazines">Books, Journals and Magazines</a>
        <ul>
          <li><a href="./Text::Metaphone.html#Binstock,-Andrew-&amp;-Rex,-John.-%22Metaphone:-A-Modern-Soundex.%22-Practical-Algorithms-For-Programmers.-Reading,-Mass:-Addion-Wesley,-1995-pp160-169">Binstock, Andrew &amp; Rex, John. &quot;Metaphone: A Modern Soundex.&quot; Practical Algorithms For Programmers. Reading, Mass: Addion-Wesley, 1995 pp160-169</a></li>
          <li><a href="./Text::Metaphone.html#Parker,-Gary.-%22A-Better-Phonetic-Search.%22-C-Gazette,-Vol.-5,-No.-4-(June/July),-1990.">Parker, Gary. &quot;A Better Phonetic Search.&quot; C Gazette, Vol. 5, No. 4 (June/July), 1990.</a></li>
          <li><a href="./Text::Metaphone.html#Philips,-Lawrence.-Computer-Language,-Vol.-7,-No.-12-(December),-1990.">Philips, Lawrence. Computer Language, Vol. 7, No. 12 (December), 1990.</a></li>
        </ul>
      </li>
    </ul>
  </li>
  <li><a href="./Text::Metaphone.html#COPYRIGHT-and-LICENSE">COPYRIGHT and LICENSE</a></li>
</ul></nav>
<div class="pod anchors">
<h1 id="NAME">NAME</h1>

<p>Text::Metaphone - A modern soundex. Phonetic encoding of words.</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>  use Text::Metaphone;

  # XWRN
  my $phoned_word = Metaphone(&#39;Schwern&#39;);</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p><code>Metaphone()</code> is a function whereby a string/word is broken down into a rough approximation of its english phonetic pronunciation. Very similar in concept and purpose to soundex, but much more comprehensive in its approach.</p>

<h1 id="FUNCTIONS">FUNCTIONS</h1>

<h3 id="Metaphone">Metaphone</h3>

<pre><code>    $phoned_word = Metaphone($word, $max_phone_len);</code></pre>

<p>Takes a word and encodes it according to the Metaphone algorithm. The algorithm only deals with alphabetical characters, all else is ignored.</p>

<p>If $max_phone_len is provided, Metaphone will only encode up to that many characters for each word.</p>

<p>&#39;sh&#39; is encoded as &#39;X&#39;, &#39;th&#39; is encoded as &#39;0&#39;. This can be changed in the metaphone.h header file.</p>

<h1 id="CAVEATS">CAVEATS</h1>

<h3 id="Metaphone-algorithm-changes"><a id="Metaphone1"></a>Metaphone algorithm changes</h3>

<p>I have made a few minor changes to the traditional metaphone algorithm found in the books. The most significant one is that it will differenciate between SCH and SCHW making the former K (As in School) and the latter sh (as in Schwartz and Schwern).</p>

<p>My changes can be turned off by defining the USE_TRADITIONAL_METAPHONE flag in metaphone.h.</p>

<p>Due to these changes, any users of Metaphone v1.00 or earlier which have stored metaphonetic encodings, they should recalculate those with the new version.</p>

<h1 id="AUTHOR">AUTHOR</h1>

<p>Michael G Schwern &lt;schwern@pobox.com&gt;</p>

<h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1>

<h2 id="Man-pages"><a id="Man"></a>Man pages</h2>

<p><a href="https://metacpan.org/pod/Text::Soundex">Text::Soundex</a> - A simpler word hashing algorithm <a href="./Text::DoubleMetaphone.html">Text::DoubleMetaphone</a> - Improved metaphone <a href="https://metacpan.org/pod/Text::Phonetic">Text::Phonetic</a> - A collection of phonetic algorithms</p>

<h2 id="Books,-Journals-and-Magazines"><a id="Books"></a><a id="Books--Journals-and-Magazines"></a>Books, Journals and Magazines</h2>

<h3 id="Binstock,-Andrew-&amp;-Rex,-John.-&quot;Metaphone:-A-Modern-Soundex.&quot;-Practical-Algorithms-For-Programmers.-Reading,-Mass:-Addion-Wesley,-1995-pp160-169"><a id="Binstock"></a><a id="Binstock--Andrew---Rex--John.--Metaphone:-A-Modern-Soundex.--Practical-Algorithms-For-Programmers.-Reading--Mass:-Addion-Wesley--1995-pp160-169"></a>Binstock, Andrew &amp; Rex, John. &quot;Metaphone: A Modern Soundex.&quot; <i>Practical Algorithms For Programmers.</i> Reading, Mass: Addion-Wesley, 1995 pp160-169</h3>

<p>Contains an explanation of the basic metaphone concept &amp; algorithm and C code from which I learned of Metaphone and ported this module.</p>

<h3 id="Parker,-Gary.-&quot;A-Better-Phonetic-Search.&quot;-C-Gazette,-Vol.-5,-No.-4-(June/July),-1990."><a id="Parker"></a><a id="Parker--Gary.--A-Better-Phonetic-Search.--C-Gazette--Vol.-5--No.-4--June-July--1990"></a>Parker, Gary. &quot;A Better Phonetic Search.&quot; <i>C Gazette</i>, Vol. 5, No. 4 (June/July), 1990.</h3>

<p>This is the public-domain C version of metaphone from which Binstock &amp; Rex based their own.. I haven&#39;t actually read it.</p>

<h3 id="Philips,-Lawrence.-Computer-Language,-Vol.-7,-No.-12-(December),-1990."><a id="Philips"></a><a id="Philips--Lawrence.-Computer-Language--Vol.-7--No.-12--December--1990"></a>Philips, Lawrence. <i>Computer Language</i>, Vol. 7, No. 12 (December), 1990.</h3>

<p>And here&#39;s the original Metaphone algorithm as presented in Pick BASIC.</p>

<h1 id="COPYRIGHT-and-LICENSE"><a id="COPYRIGHT"></a>COPYRIGHT and LICENSE</h1>

<p>Copyright (c) 1997, 1999, 2007-2008 Michael G Schwern. All Rights Reserved.</p>

<p>This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p></div>

<div id="metacpan_install-instructions-dialog" class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Module Install Instructions</h4>
      </div>
      <div class="modal-body">
        <p>To install Text::Metaphone, copy and paste the appropriate command in to your terminal.</p>
        <p><a href="https://metacpan.org/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p>
        <pre><code>cpanm Text::Metaphone</code></pre>
        <p><a href="https://metacpan.org/pod/CPAN">CPAN shell</a></p>
        <pre><code>perl -MCPAN -e shell
install Text::Metaphone</code></pre>
        <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p>
      </div>
      <div class="modal-footer">
        <a href="./Text::Metaphone.html#" data-dismiss="modal" class="btn">Close</a>
      </div>
    </div>
  </div>
</div>
          </main>
          <div class="content-pagination">
          </div>
        </div>
        <footer class="footer">
          <div class="footer-container">
            <div class="footer-social">
              <div class="footer-link footer-logo">
                <a href="https://metacpan.org/">
                  <img src="https://metacpan.org/static/images/metacpan-logo.svg" alt="MetaCPAN" />
                </a>
              </div>
              <a class="footer-social-link" href="https://github.com/metacpan">
                <i class="fab fa-github-square"></i>
              </a>
              <a class="footer-social-link" href="https://fosstodon.org/@metacpan">
                <i class="fab fa-mastodon"></i>
              </a>
            </div>
            <div class="footer-links">
              <div class="footer-link">
                  <a href="https://metacpan.org/about">About</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/sponsors">Sponsor</a>
              </div>
              <div class="footer-link">
                  <a href="https://grep.metacpan.org">grep::cpan</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/recent">Recent</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/faq">FAQ</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/tools">Tools</a>
              </div>
              <div class="footer-link">
                  <a href="https://fastapi.metacpan.org/">API</a>
              </div>
              <div class="footer-link">
                  <a href="https://www.perl.org/">Perl.org</a>
              </div>
            </div>
            <div class="footer-sponsors">
              <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener">
                <img class="footer-sponsor-bytemark" src="https://metacpan.org/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener">
                <img class="footer-sponsor-liquidweb" src="https://metacpan.org/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener">
                <img class="footer-sponsor-deriv" src="https://metacpan.org/static/images/sponsors/deriv.svg" alt="Deriv logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener">
                <img class="footer-sponsor-geocode" src="https://metacpan.org/static/images/sponsors/geocodelogo.svg" alt="Geocode logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener">
                <img class="footer-sponsor-fastly" src="https://metacpan.org/static/images/sponsors/fastly_logo.svg" alt="Fastly logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener">
                <img class="footer-sponsor-opencage" src="https://metacpan.org/static/images/sponsors/open-cage.svg" alt="OpenCage logo">
              </a>
            </div>
          </div>
        </footer>
        <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts">
          <div class="modal-dialog">
            <div class="modal-content">
              <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal">&times;</button>
                <h4 class="modal-title">Keyboard Shortcuts</h4>
              </div>
              <div class="modal-body row">
<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Global</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>s</kbd>
        </td>
        <td>Focus search bar</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>?</kbd>
        </td>
        <td>Bring up this help dialog</td>
      </tr>
    </tbody>
  </table>

  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>GitHub</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>p</kbd>
        </td>
        <td>Go to pull requests</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>go to github issues (only if github is preferred repository)</td>
      </tr>
    </tbody>
  </table>
</div>

<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>POD</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>a</kbd>
        </td>
        <td>Go to author</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>c</kbd>
        </td>
        <td>Go to changes</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>Go to issues</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>d</kbd>
        </td>
        <td>Go to dist</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>r</kbd>
        </td>
        <td>Go to repository/SCM</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>s</kbd>
        </td>
        <td>Go to source</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>b</kbd>
        </td>
        <td>Go to file browse</td>
      </tr>

    </tbody>
  </table>
</div>

<div class="col-md-12">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Search terms</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><em>module:</em> (e.g. <a href="https://metacpan.org/search?q=module%3APlugin">module:Plugin</a>)</td>
      </tr>
      <tr>
        <td><em>distribution:</em> (e.g. <a href="https://metacpan.org/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td>
      </tr>
      <tr>
        <td><em>author:</em> (e.g. <a href="https://metacpan.org/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td>
      </tr>
      <tr>
        <td><em>version:</em> (e.g. <a href="https://metacpan.org/search?q=version%3A1.00">version:1.00</a>)</td>
      </tr>
    </tbody>
  </table>
</div>
              </div>
              <div class="modal-footer"></div>
            </div>
          </div>
        </div>
    </body>
</html>
